home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / usenet / sources / volume91 / aplictns / quiz_1_0 / part01 / README < prev    next >
Text File  |  1991-04-10  |  7KB  |  181 lines
  1. 20 March 1991
  2.  
  3. Quiz 1.0
  4.  
  5. 1. INTRODUCTION
  6.  
  7. This is the first release of quiz, a simple question-answer program
  8. similar to the unix program /usr/games/quiz.  It is useful for
  9. memorizing vocabulary or other information that can be related in
  10. pairs, for example, country names and their capital cities.
  11.  
  12. Given an input file of questions and answers, quiz will ask the user
  13. questions and grade the user's answers.  The program can be run from
  14. CLI or workbench.  (I haven't made a nice icon for it yet.)   You can
  15. use data files from /usr/games/quiz as well.  Simply type:
  16.  
  17.  CLI> quiz [quizfile] [-switch] [-help] [-ignorecase]
  18.  
  19. Argument order doesn't matter and you can abbreviate the options to a
  20. single letter (i.e. "-s").  Options:
  21.  
  22.    -switch: Asks the answer and expects question.
  23.  
  24.    -ignorecase: case doesn't matter
  25.  
  26.    -help: displays a brief help message and exits
  27.  
  28. Quiz records and can graph previous sessions to show your progress
  29. over time.
  30.  
  31. 2. EXAMPLE SESSION
  32.  
  33. As an example, try:
  34.  
  35.   1> quiz nihongo1
  36.  
  37. Quiz will open up a new screen.  Since we have specified a question
  38. file, quiz begins by quizzing us right away.  Type your answer to the
  39. question in the text gadget.  Quiz will ask all of the questions from
  40. the data file in a random order until you get them all right.  If you
  41. miss any particular question more than four times (#define'd as
  42. MAXWRONG in "qstructs.h") quiz will assume you are hopeless on that
  43. question and not ask it again.  You now know enough to use the basic
  44. features of quiz.  Read on only if you want details.
  45.  
  46. After you have answered all the questions, a list of the questions you
  47. missed and your score will be printed on the CLI from which you
  48. started quiz.
  49.  
  50. 3. COMMANDS
  51.  
  52. To load a new file, type the file name in the same text gadget that is
  53. used for answers.  Then select "Load" from the main menu or use
  54. "Right-Amiga L".  The session will begin immediately.  After a session
  55. is complete, you can rerun it by selecting "Begin" from the main menu
  56. or by using the keyboard equivalent (Right-Amiga b).  "Quit" from the
  57. main menu will end the quiz session.
  58.  
  59. 4. HISTORY GRAPHING
  60.  
  61. After the first time you answer a question file, subsequent sessions
  62. will show the history of your progress in one of two ways.  The
  63. default graph is a bar graph that shows how often you answered each
  64. question incorrectly.  I.e., the higher the bar, the more times you
  65. have missed that question.  Clicking on a question's bar will make
  66. quiz switch to that question immediately.  The previously displayed
  67. question will be asked again later.  Switch to the questions graph by
  68. selecting "Graph ?'s" from the Options menu (or use Right-Amiga ?).
  69.  
  70. Questions not yet answered are shown in flesh-color.  Questions
  71. answered correcty the first time are shown in sky blue.  Those that
  72. have been missed at least once are shown in a kind of reddish-brown.
  73.  
  74. The other graph shows your total score across many sessions for a
  75. particular data file.  Select this graph from the Options menu "Graph
  76. Trials" selection (or use Right-Amiga t).  Clicking on a bar in this
  77. mode has no meaning.
  78.  
  79. Quiz saves history information for question file "quizdata" in
  80. "quizdata.sc".  In order to save history information, there must be
  81. room on the quiz data volume and it must be writable.
  82.  
  83. 5. OTHER OPTIONS
  84.  
  85. Other options are available from the Options menu as follows:
  86.  
  87.   5.1  Switch      (Right-Amiga s)
  88.        Simply switches the question and answer.  Thus you will be given
  89.        the answer and have to provide the question.  (No fair using
  90.        this to cheat.)
  91.  
  92.   5.2  Ignore Case (Right-Amiga i)
  93.        If Ignore Case is selected, case does not matter.  I.e., "CaT"
  94.        would match "cat".  Default is that case DOES matter.
  95.  
  96.   5.3  Abort       (Right-Amiga a)
  97.        Selecting abort causes the current trial to end.  A history
  98.        entry will not be written.
  99.  
  100. 6. THE QUESTION FILE
  101.  
  102. A quiz data file contains lines of the form:
  103.  
  104. question:answer
  105.  
  106. In the simplest case, this could be something like:
  107.  
  108. Largest state in the US:Alaska
  109.  
  110. You can specify more than one match by using '|'.  For example:
  111.  
  112. First President of the US:George Washington|George|Washington
  113.  
  114. Thus any of "George", "Washington" or "George Washington" would be a
  115. correct response to this question.  In addition, '{' and '}' can be
  116. used to save typing and disk space.  Brackets can be nested to any
  117. depth.  Trailing and leading white space is deleted in an entry and in
  118. the user's answer.
  119.  
  120. Quiz {Author|Programmer}:{Curtis|C{.} {R}} Eubanks
  121.  
  122. This question patterns matches: (only one will be displayed as the
  123. question)
  124.  
  125.   Quiz Author
  126.   Quiz Programmer
  127.  
  128. and the answer pattern:
  129.   Curtis Eubanks
  130.   C Eubanks
  131.   C. Eubanks
  132.   C R Eubanks
  133.   C. R Eubanks
  134.  
  135. Note that {.} matches both the empty string and '.'.
  136.  
  137. Several example files are included.  When you finish a quiz session, a
  138. score file is written: "quizfile.sc" and appended to each additional
  139. time the program is run with quizfile.  Each line of this file contains
  140. a list of the missed questions.
  141.  
  142. 7. THE THUMB
  143.  
  144. The thumb doesn't mean anything yet, but if you click on it, it changes
  145. state.  Use it to boost your morale or something.
  146.  
  147. 8.  THE CODE
  148.  
  149. This was written on a plain Amiga 1000 over a year ago.  I compiled it
  150. with Lattice 3.10.  To compile, execute the following lattice commands:
  151.  
  152.  1> lc -ac screen
  153.  1> lc quiz parse mymalloc graph
  154.  1> blink with quiz-with
  155.  
  156. This program is public domain.  I wouldn't mind getting a $10 or $15
  157. donation if you find it useful, but I don't require it.  If I ever
  158. make an significant update, anyone who sends me $15 or more will
  159. receive the new version.  This program can be freely distributed as
  160. long as all of the files in this directory are included.  If you make
  161. any changes to the code, please let me know before redistributing.
  162.  
  163. I hope you enjoy "quiz" and that you find it useful---it has been for
  164. me. 
  165. There are undoubtedly bugs in the code.  If you find any, please let
  166. me know.  (If possible, provide a fix.)  I have not tested this code on
  167. anything other than an Amiga 1000.  Also drop me a note if you find
  168. errors in this documentation, or if you feel any part is unclear/not
  169. detailed enough/too detailed. 
  170.  
  171. Any questions or comments are always welcome.  Mail to any of the
  172. following will get to me (if you are sending money in US dollars, it
  173. is better to send it to the US address):
  174.  
  175.    creubank@is.crl.sony.co.jp   creubank@media-lab.media.mit.edu
  176.  
  177.    Curtis Eubanks               Curtis Eubanks
  178.    Mezon Marukyo Rm 201         c/o Vernon Eubanks
  179.    5-38-10 Minami-magome        6984 Y Lightning Ranch Rd.
  180.    Oota-ku, Tokyo 143 JAPAN     Hereford, AZ 85616 USA
  181.